Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up README files to be more clear and helpful #158

Merged
merged 1 commit into from Jan 18, 2013

Conversation

mixonic
Copy link
Contributor

@mixonic mixonic commented Dec 12, 2012

Howdy!

Great gem, but boy was it frustrating to figure out how to use it. The sub-readme files are confusing, and some of the documentation is just out of date.

This set of changes cleans things up. I've removed links to https://github.com/jodosha/redis-store/wiki/Frameworks-Configuration, which I recommend be removed. It is out of date and confusing. Everything it covers should be covered in the readmes now.

  • Move build status to the top of the main readme.
  • Move to two-space tabs, like most of the Rails community.
  • Drop redis installation instructions from every readme.
  • Correct the build instructions. Install before exec.
  • Refer users to redis-rails from the individual gems.
  • Update the redis-rails readme to be more up-to-date.
  • Use Ruby 1.9 conventions for code samples.

jodosha added a commit that referenced this pull request Jan 18, 2013
Clean up README files to be more clear and helpful
@jodosha jodosha merged commit dd8d211 into redis-store:master Jan 18, 2013
@mixonic mixonic deleted the documentation branch January 18, 2013 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants